Standardize documentation to use INSERT with comma-separated patterns #17
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updates all documentation to follow ISO GQL standard and best practices: - Replace CREATE keyword with INSERT (ISO GQL standard) - Use comma-separated patterns for multiple node insertions instead of separate statements (single atomic transaction vs multiple) - Add clarifying comments explaining single vs multiple node patterns - Remove unnecessary variable bindings when not used Files updated: - Main README.md and all binding READMEs (Java, Python, SDK) - Documentation guides (Quick Start, Getting Started With GQL) - Add comprehensive JSON format test suite (json_format_tests.rs) - Add debug output to pattern_tests.rs for NEXT clause investigation Technical rationale: - CREATE and INSERT are synonyms (parser.rs:3933-3936) - Comma-separated pattern is more efficient (1 transaction vs N) - Parser supports comma-separated syntax (parser.rs:3937) - Atomic all-or-nothing semantics
arvikar83
reviewed
Nov 24, 2025
arvikar83
reviewed
Nov 24, 2025
arvikar83
approved these changes
Nov 24, 2025
Collaborator
arvikar83
left a comment
arvikar83
left a comment
There was a problem hiding this comment.
Approval Note:
Local CI tests may fail as a recent commit may have reintroduced Doc-Tests, although the same is currently skipped from the prod CI pipeline.
Approving thus, as prod CI is successful.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates all documentation to follow ISO GQL standard and best practices:
Files updated:
Technical rationale: